<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title></title>
			<link rel="stylesheet" href="media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
						<h1 align="center">README</h1>
<pre>
uTorrent Bridge v0.2.0
======================
	A Modular uTorrent WebUI Bridge. 

DESCRIPTION:
------------
	uTorrent Bridge allows you to perform native uTorrent WebUI requests on non-native servers. 
	This enables uTorrent remotes such as uRemote and Torrent-fu on non-uTorrent servers like
	rTorrent and Transmission.
	
	Non-native server interaction is provided by modular, community created, server libraries. 

	Basic Process:
		1. uTorrent Client -&gt; Native Request -&gt; Bridge
		2. Bridge -&gt; Translated Request -&gt; Server
		3. Server -&gt; Non-native Response -&gt; Bridge
		4. Bridge -&gt; Translated Response -&gt; uTorrent Client 

INCLUDES:
--------
	Modules:
		Server modules are located in the &quot;./gui/servers/*&quot; directory.  
		Server modules must implement the utb_server_interface interface.
		Server modules may be deleted if unused.
	
	Service:
		The script functions as a bridge in real-time. 
		Files should be located at http://server/gui/. 
		The included token.html dummy file should is used to bypass uTorrent's token
			authentication.

MODULES:
--------
	rTorrent - http://libtorrent.rakshasa.no
		Text-based ncurses BitTorrent client, based on the libTorrent libraries, for Unix.
	
		Supported:
			Retrieve transfer list		
			Retrieve transfer files
			Retrieve transfer properties
			Perform transfer actions
		Development:		
			Retrieve transfer labels
			Retrieve server settings
			Modify transfer labels
			Modify system settings
			Modify transfer properties
			Modify file priority
		Unsupported:
			64 bit integers
	
TODO:
-----
	!!!SERVER MODULES NEEDED!!!
	Please help this project grow by providing server support!
	!!!SERVER MODULES NEEDED!!!

	Support Transmission server backends - http://www.transmissionbt.com
	Support Deluge server backends - http://deluge-torrent.org 

	Support transfer labels.
	Support file addition via HTTP POST.
	Support file priority modification.
	Support transfer property modification.
	Support server setting modification.

CHANGELOG:
----------
	2009-09-04:
		Recoded entire project. 
		Removed bloat.
		Improved coding style. 
		Improved documentation.
	2009-07-01:
		Added more comprehensive logging.
	2009-06-29:
		Added bridge classes.
		Added documentation.
	
AUTHORS:
--------
	Ryon Sherman

LICENSE:
--------
	The GNU Public License - http://www.gnu.org/licenses/gpl.txt

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.
	
	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

INFORMATION:
------------
	Authors:
		Ryon Sherman's Blog
			http://ryonsherman.blogspot.com/

	uTorrent:
		uTorrent is a trademark of BitTorrent, Inc.
			http://www.utorrent.com/
		uTorrent WebUI API
			http://forum.utorrent.com/viewtopic.php?id=25661

	rTorrent:
		PHP XML-RPC
			http://us.php.net/manual/en/book.xmlrpc.php
		Using XMLRPC with rtorrent
			http://libtorrent.rakshasa.no/wiki/RTorrentXMLRPCGuide
		Draft reference for XMLRPC commands for rTorrent
			http://code.google.com/p/gi-torrent/wiki/rTorrent_XMLRPC_reference

</pre>
	<p class="notes" id="credit">
		Documentation generated on Wed, 16 Dec 2009 10:32:53 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</body>
</html>